<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Dingo.pluginManager.Plugin</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Dingo-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/dingo-wsn/">Dingo</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Dingo-module.html">Package&nbsp;Dingo</a> ::
        <a href="Dingo.pluginManager-module.html">Module&nbsp;pluginManager</a> ::
        Class&nbsp;Plugin
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Dingo.pluginManager.Plugin-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Plugin</h1><br /><br />
<center>
<center>  <map id="uml_class_diagram_for_dingo_pl" name="uml_class_diagram_for_dingo_pl">
<area shape="rect" href="Dingo.plugins.null.NullPlugin&#45;class.html" title="Null plugin for debugging." alt="" coords="16,211,157,237"/>
<area shape="rect" href="Dingo.plugins.adcevents.ADCReadingsPlugin&#45;class.html" title="Plot values read on real or simulated ADCs." alt="" coords="208,211,451,237"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#name" title="Name of this plugin." alt="" coords="215,28,444,47"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#graphPane" title="reference to the network pane in the Dingo GUI." alt="" coords="215,47,444,65"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#createMenu" title="Create a menu which Dingo will add as a submenu in the Plugins menu of the  GUI." alt="" coords="215,68,444,87"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#deactivate" title="Deactivate this plugin." alt="" coords="215,87,444,105"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#activate" title="Activate this plugin." alt="" coords="215,105,444,124"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#createContextMenu" title="Create a menu which will be available when users right&#45;click on a network  node." alt="" coords="215,124,444,143"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#__init__" title="Dingo.pluginManager.Plugin.__init__" alt="" coords="215,143,444,161"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html" title="Superclass for Dingo plugins." alt="" coords="213,11,445,163"/>
<area shape="rect" href="Dingo.pluginManager.PluginPanel&#45;class.html" title="Panel added to the notebook page of the Dingo GUI." alt="" coords="501,211,584,237"/>
<area shape="poly" href="Dingo.pluginManager.Plugin&#45;class.html#panel" title="Dingo.pluginManager.Plugin.panel" alt="" coords="447,159 512,200 509,205 444,164"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#panel" title="Dingo.pluginManager.Plugin.panel" alt="" coords="441,157,449,165"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#panel" title="Dingo.pluginManager.Plugin.panel" alt="" coords="519,207,527,215"/>
<area shape="rect" href="Dingo.pluginManager.Plugin&#45;class.html#panel" title="panel" alt="" coords="493,178,524,195"/>
<area shape="rect" href="Dingo.plugins.debug.DebugPlugin&#45;class.html" title="Builtin debug plugin for debugging simulations or deployments." alt="" coords="635,211,805,237"/>
</map>
  <img src="uml_class_diagram_for_dingo_pl.gif" alt='' usemap="#uml_class_diagram_for_dingo_pl" ismap="ismap" class="graph-without-title" />
</center></center>
<hr />
Superclass for Dingo plugins.<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span></td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Dingo.pluginManager.Plugin-class.html#activate" class="summary-sig-name">activate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Activate this plugin.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Dingo.pluginManager.Plugin-class.html#deactivate" class="summary-sig-name">deactivate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Deactivate this plugin.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">wx.Menu</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Dingo.pluginManager.Plugin-class.html#createMenu" class="summary-sig-name">createMenu</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Create a menu which Dingo will add as a submenu in the Plugins 
      menu of the GUI.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">wx.Menu</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Dingo.pluginManager.Plugin-class.html#createContextMenu" class="summary-sig-name">createContextMenu</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Create a menu which will be available when users right-click on a 
      network node.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">str</span>
    </td><td class="summary">
        <a href="Dingo.pluginManager.Plugin-class.html#name" class="summary-name">name</a><br />
      Name of this plugin.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Dingo.pluginManager.PluginPanel</span>
    </td><td class="summary">
        <a name="panel"></a><span class="summary-name">panel</span><br />
      GUI panel available to this plugin.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Dingo.OGL.SensorCanvas</span>
    </td><td class="summary">
        <a name="graphPane"></a><span class="summary-name">graphPane</span><br />
      reference to the network pane in the Dingo GUI.
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="activate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">activate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </table>
  
  Activate this plugin. <b>Must</b> be overridden by in 
  <code>Plugin</code> subclasses.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="deactivate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">deactivate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </table>
  
  Deactivate this plugin. <b>Must</b> be overridden by in 
  <code>Plugin</code> subclasses.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="createMenu"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">createMenu</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </table>
  
  Create a menu which Dingo will add as a submenu in the Plugins menu of
  the GUI. May (optionally) be overridden by plugins.
  <dl class="fields">
    <dt>Returns: wx.Menu</dt>
  </dl>
</td></tr></table>
</div>
<a name="createContextMenu"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">createContextMenu</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </table>
  
  Create a menu which will be available when users right-click on a 
  network node. May (optionally) be overridden by plugins.
  <dl class="fields">
    <dt>Returns: wx.Menu</dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
<a name="section-InstanceVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Variable Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceVariableDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">name</h3>
  Name of this plugin. Used in menus, etc. so <b>must</b> be short.
  <dl class="fields">
    <dt>Type:</dt>
      <dd>str</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Dingo-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/dingo-wsn/">Dingo</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0beta1 on Tue Jun  3 00:42:56 2008</a>
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
